Delete Specific SIP Connection

The Delete Specific SIP Connection request removes a SIP Connection from Live Platform.

URI

Copy

{{baseUrl}}/api/v2/sitelocation/{sbcSiteGuid}

HTTP Method

DELETE

Request Parameter

Parameter	Type	Description
sbcSiteGuid	string $uuid	The Unique Id for the SIP Connection (Site Location). Retrieve value "Id" using the Get Specific Customer Details request; search for the SIP Connection that you wish to remove and then copy the respective 'Id".

Example Response

The initial response displays the Task Id.

Parameter	Type	Description
Task Id	string	The queued task Id that is generated for this action. You must run the Task request to retrieve the status of the action. See Task Status. Note that the wup string in the prefix is unique for this request.

Copy

{
    "status": true,
    "msg": "queued",
    "sbcCleanupTaskId": "tsk_841026",
    "o365CleanupTask": "tsk_0"
}

Once the request has been executed, the "Completed Success" status is displayed. You can run the Get Specific Customer Details request to confirm that the SIP Connection has been removed.

Copy

{
    "id": "tsk_841026",
    "status": "CompletedSuccess",
    "details": [
        null
    ],
    "executionMessages": [],
    "outputData": {}
}

HTTP Responses

■

200 OK

■

404 Not Found